Skip to content

feat: optimized IO file logger [WPB-21373] #4078

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 30 commits into from
Oct 28, 2025
Merged

feat: optimized IO file logger [WPB-21373] #4078

merged 30 commits into from
Oct 28, 2025

Conversation

@MohamadJaara
Copy link
Member

@MohamadJaara MohamadJaara commented Jun 23, 2025 •
edited by github-actions bot
Loading

TaskWPB-21373 [Android] file logger doing IO call for each log line

PR Submission Checklist for internal contributors

  • The PR Title

    • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
    • contains a reference JIRA issue number like SQPIT-764
    • answers the question: If merged, this PR will: ... ³

  • The PR Description

    • is free of optional paragraphs and you have filled the relevant parts to the best of your ability

What's new in this PR?

Issues

the current LogFileWriter have some short comming

  1. it start a new new file writer for each line
  2. it flushes each log line directly into storage creating

Solutions

  1. create a new async logger
  2. buffer log lines and flushes with a set interval
  3. since the logger is now async add a crash handler to make sure crashes are logged
  4. also when the app start check if there are any oom or ANRs from the previous app start
  5. have a dedicated process that listens to logcat
  6. keep the old logger as it is and enable the new one only in internal builds

Needs releases with:

  • GitHub link to other pull request

Testing

Test Coverage (Optional)

  • I have added automated test to this contribution

How to Test

Briefly describe how this change was tested and if applicable the exact steps taken to verify that it works as expected.

Notes (Optional)

Specify here any other facts that you think are important for this issue.

Attachments (Optional)

Attachments like images, videos, etc. (drag and drop in the text box)

PR Post Submission Checklist for internal contributors (Optional)

  • Wire's Github Workflow has automatically linked the PR to a JIRA issue

PR Post Merge Checklist for internal contributors

  • If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.
References
  1. https://sparkbox.com/foundry/semantic_commit_messages
  2. https://github.com/wireapp/.github#usage
  3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

@MohamadJaara MohamadJaara changed the title Mo/feat/thred safe logging feat: reduced IO logger Jun 23, 2025
@codecov
Copy link

codecov bot commented Jun 23, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 0% with 214 lines in your changes missing coverage. Please review.
✅ Project coverage is 47.20%. Comparing base (7250b49) to head (0b9e4ec).

Files with missing lines Patch % Lines
...m/wire/android/util/logging/LogFileWriterV2Impl.kt 0.00% 168 Missing ⚠️
...rc/main/kotlin/com/wire/android/WireApplication.kt 0.00% 34 Missing ⚠️
...wire/android/util/logging/LogFileWriterV2Config.kt 0.00% 7 Missing ⚠️
...in/com/wire/android/ui/debug/UserDebugViewModel.kt 0.00% 2 Missing ⚠️
...m/wire/android/util/logging/LogFileWriterV1Impl.kt 0.00% 2 Missing ⚠️
...lin/com/wire/android/util/logging/LogFileWriter.kt 0.00% 1 Missing ⚠️

❌ Your patch check has failed because the patch coverage (0.00%) is below the target coverage (80.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files 
@@             Coverage Diff             @@
##           develop    #4078      +/-   ##
===========================================
- Coverage    47.77%   47.20%   -0.58%     
===========================================
  Files          527      530       +3     
  Lines        17375    17586     +211     
  Branches      2959     2988      +29     
===========================================
  Hits          8301     8301              
- Misses        8187     8398     +211     
  Partials       887      887
Files with missing lines Coverage Δ
...re/android/notification/WireNotificationManager.kt 80.18% <ø> (ø)
...in/com/wire/android/services/CallServiceManager.kt 94.73% <ø> (ø)
...in/kotlin/com/wire/android/util/logging/LogUtil.kt 0.00% <ø> (ø)
...lin/com/wire/android/util/logging/LogFileWriter.kt 0.00% <0.00%> (ø)
...in/com/wire/android/ui/debug/UserDebugViewModel.kt 0.00% <0.00%> (ø)
...m/wire/android/util/logging/LogFileWriterV1Impl.kt 0.00% <0.00%> (ø)
...wire/android/util/logging/LogFileWriterV2Config.kt 0.00% <0.00%> (ø)
...rc/main/kotlin/com/wire/android/WireApplication.kt 0.00% <0.00%> (ø)
...m/wire/android/util/logging/LogFileWriterV2Impl.kt 0.00% <0.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7250b49...0b9e4ec. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Contributor

Built wire-android-staging-compat-pr-4078.apk is available for download

@github-actions
Copy link
Contributor

Built wire-android-dev-debug-pr-4078.apk is available for download

@MohamadJaara MohamadJaara changed the title feat: reduced IO logger feat: optimized IO file logger Jul 7, 2025
@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
8.4% Duplication on New Code

See analysis details on SonarQube Cloud

@github-actions
Copy link
Contributor

Built wire-android-staging-compat-pr-4078.apk is available for download

@github-actions
Copy link
Contributor

Built wire-android-dev-debug-pr-4078.apk is available for download

@github-actions
Copy link
Contributor

This PR is stale because it has been open 30 days with no activity. Please update it or close it in case is not relevant anymore.

@github-actions github-actions bot added the stale Inactivity alert label Aug 18, 2025
@MohamadJaara
Merge branch 'develop' into mo/feat/thred-safe-logging
d4068f8 
# Conflicts:
#	app/src/androidTest/kotlin/com/wire/android/ui/debug/DebugScreenComposeTest.kt
#	app/src/main/kotlin/com/wire/android/services/CallService.kt
@stale stale bot removed the stale Inactivity alert label Aug 20, 2025
@MohamadJaara
detekt
8268a73
@MohamadJaara
Merge branch 'develop' into mo/feat/thred-safe-logging
f1dfbae 
# Conflicts:
#	app/src/main/kotlin/com/wire/android/ui/debug/DebugScreen.kt
#	buildSrc/src/main/kotlin/customization/FeatureConfigs.kt
#	default.json
@MohamadJaara
fix merge conflicts
abf7c44
yamilmedina
yamilmedina reviewed Oct 7, 2025
View reviewed changes
Copy link
Contributor

@yamilmedina yamilmedina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, gave a few suggestions about resource closure and a couple of questions.

@MohamadJaara MohamadJaara force-pushed the mo/feat/thred-safe-logging branch from afc0c1a to e6cc9de Compare October 8, 2025 09:34
yamilmedina
yamilmedina approved these changes Oct 8, 2025
View reviewed changes
Copy link
Contributor

@yamilmedina yamilmedina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@MohamadJaara MohamadJaara changed the title feat: optimized IO file logger feat: optimized IO file logger [WPB-21373] Oct 23, 2025
@sonarqubecloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
8.4% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

@MohamadJaara MohamadJaara added this pull request to the merge queue Oct 28, 2025
Merged via the queue into develop with commit a5982fa Oct 28, 2025
15 of 17 checks passed
@MohamadJaara MohamadJaara deleted the mo/feat/thred-safe-logging branch October 28, 2025 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yamilmedina yamilmedina yamilmedina approved these changes

@vitorhugods vitorhugods vitorhugods approved these changes

Assignees

@MohamadJaara MohamadJaara

Labels

size/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@MohamadJaara @yamilmedina @vitorhugods